/*
*  Copyright (C) 2009  Peter Kist & Jan Ripke
*
*  This program is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  This program is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __gfx_ogre3d_menu_h
#define __gfx_ogre3d_menu_h 1

#include <string>

#include <Core/Interface/Logic.h>

namespace CEGUI {
    class System;
    class Renderer;
    class Window;
}

namespace galaxy {
    namespace gfx {
        namespace ogre3d {
            namespace gui {

                typedef const std::string ElementName;

                class MenuManager;

                class Menu
                {
                    friend class MenuManager;

                protected:

                    gui::MenuManager * m_MenuManager;
                    CEGUI::Window    * m_Window;       /**< the loaded gui window */

                    Menu (void) { }; /**< intentionally private */

                public:

                    Menu(MenuManager& menuManager)
                        : m_MenuManager (&menuManager), m_Window(0L) { };
                    virtual ~Menu(void);

                    /** load the corresponding menu. The menu is loaded or created */
                    virtual bool load () = 0;
                    /** setup any gui event handlers or other setup stuff */
                    virtual bool setup () { return true; };
                    /** the menu is unloaded from memory */
                    virtual bool unload () = 0;

                    CEGUI::Window * getWindow () { return m_Window; };

                    /** the menu's name */
                    virtual const char * menuName () = 0;

                protected:
                    bool changeState (logic::State::Name);

                };

            } // namespace gui
        } // namespace ogre3d
    } // namespace gfx
} // namespace galaxy

#endif // __gfx_ogre3d_menu_h
